Added ADRs 008, 009 #253
Added ADRs 008, 009 #253
Conversation
| @@ -0,0 +1,35 @@ | |||
| # ADR 008 - Improved developer experience | |||
There was a problem hiding this comment.
The title (and file name)should reflect the technical decision. "Improved developer experience" is the context, the decision is "mono-repo", or "use single repository"
|
|
||
| ## Context | ||
|
|
||
| When a new feature is added to the system, it often depends on changes to multiple repositories, at the same time. |
There was a problem hiding this comment.
With the current multi-repository setup, when a new feature ....
| When a new feature is added to the system, it often depends on changes to multiple repositories, at the same time. | ||
| This split across the repositories complicates the development process. | ||
|
|
||
| Another part of this is the maintenance of the repositories. It is important that the code uses up-to-date |
There was a problem hiding this comment.
Another part of this is dependency management and maintenance across multiple repositories. It is important ...
|
|
||
| ## Decision | ||
|
|
||
| We gather the different repositories of the OS2Display project into one repository (the API repository) and |
There was a problem hiding this comment.
We gather the code in os2display/display-api-service repository. The os2display/display-client, os2display/display-admin-client and os2display/display-templates repositories will be merged into os2display/display-api-service.
The os2display/display-api-servicerepository will be renamed to os2display/display
There was a problem hiding this comment.
The os2display/display-docs repository will be kept separate to avoid coupling usage updates to releases.
| We gather the different repositories of the OS2Display project into one repository (the API repository) and | ||
| rename it from os2display/display-api-service to os2display/display. | ||
|
|
||
| Symfony will handle the routes for the admin and client. |
There was a problem hiding this comment.
Given our misunderstanding when discussing this, this should be clarified further:
Symfony routes and controllers will be added for /client and /admin to handle serving and configuring the screen and admin clients. This will enable us to move config for the two clients to env and expose directly in html through twig templates.
The static build javascript files will be served directly by nginx from /public
| ## Decision | ||
|
|
||
| We remove the option of loading external templates into the system (remote components) and | ||
| replacing it with templates that are a part of the code. |
There was a problem hiding this comment.
| replacing it with templates that are a part of the code. | |
| replace it with templates that are a part of the code. The `os2display/display-templates` will be merged with the `os2display/display-api-service` repository (See ADR-008) |
Co-authored-by: Ture Gjørup <[email protected]>
Co-authored-by: Ture Gjørup <[email protected]>
Co-authored-by: Ture Gjørup <[email protected]>
Link to issue
#249
Link to ticket
https://leantime.itkdev.dk/#/tickets/showTicket/4565
Description